home *** CD-ROM | disk | FTP | other *** search
- =============================================================================
- Most of this document is an excerpt from Loren J. Rittle's README for the
- 3.3ljr Ispell archive (the file has been renamed to "LJR.README").
- =============================================================================
-
- Overview of the ARexx Server Mode of ISpell
-
- By no surprise, currently under the AmigaOS client-server relations are
- most easily implemented with ARexx. Requests and replies take the form of
- ARexx messages. The only limitation of using ARexx in order to implement
- client-server relations is that the client and the server must run on the
- same Amiga. Hopefully, this restriction will be lifted with the advent of
- support on the Amiga for real networking protocols (TCP/IP and others).
-
- ISpell can be started up in server mode with the following command:
-
- run <nil: >nil: ispell -r <nil: >nil:
-
- Once the server has been started, it is a good idea to wait for the ISpell
- ARexx port to show up before trying to use it. The ISpell's ARexx port
- name is IRexxSpell and the easiest way to wait for it's arrival is with the
- following command,
-
- waitforport 'IRexxSpell'
-
- For thoses of you who are excited to see the ISpell ARexx server work type,
-
- rx "options results;address 'IRexxSpell' check ites;say result"
-
- at a Shell prompt.
-
- You should see the computer respond with,
-
- & BITES CITES ICES IRES ITEM ITEMS ITS KITES RITES SITES TIES
-
- Or, if you have installed the ARexx front-end scripts into your REXX:
- directory then try typing,
-
- spell ites
-
- The computer should respond with,
-
- The word 'ites' is not found. Try these words: bites cites ices
- ires item items its kites rites sites ties
-
- Please see the README's interfaces/ directory tree for other interfaces
- available.
-
- Feel free to write your own front-ends or modify the ones that I have
- supplied. Below are the ARexx commands that ISpell knows how to respond
- to. See my examples in the rexx directory for exact usage. Have fun and
- please give the improved or new front-ends to ISpell away for all to see
- and play with.
-
-
- Commands that the ISpell Server Will Respond To
-
- ADD <word> --- Adds a word to the `global personal dictionary'
- and immediately save the personal dictionary
- to disk.
-
- QUICKADD <word> --- Adds a word as above, without saving changes
- to the file on disk. An ADD command will
- record any QUICKADD's since the last ADD.
- If the server is shut down (or the Amiga's
- power is lost), then all QUICKADD'ed words
- are lost if no ADD was performed.
-
- ACCEPT <word> --- Accept word for the rest of this Ispell session.
- The word is *not* added to the dictionary!
-
- CHECK <word> --- The ISpell server checks the stated word in its
- dictionary and returns a string that describes
- if the word was found or, if not, replacements.
- This return string is documented in man/ispell.1,
- it is the same as if words were piped in via
- standard in. See rexx/spell.rexx and
- rexx/ced/WordSpell.ced for how to parse the
- returned string in ARexx.
-
- Excerpt taken from man/ispell.1:
- If the word was found in the main dictionary, or your personal dictionary,
- then the line contains only a '*'. If the word was found through suffix
- removal, then the line contains a '+', a space, and the root word. If the
- word is not in the dictionary, but there are near misses, then the line
- contains an '&', a space, and a list of the near misses separated by
- spaces.
-
- Also, each near miss is capitalized the same as the input word if unless
- such capitalization is illegal; in the latter case each near miss is
- capitalized correctly according to the dictionary. Finally, if the word
- neither appears in the dictionary, and there are no near misses, then the
- line contains only a '#'. This mode is also suitable for interactive use
- when you want to figure out the spelling of a single word.
-
- QUICKCHECK <word> --- As above, but only checks to see if the
- word is in the dictionary. Does not try
- to find close matches, etc. See
- rexx/ced/QuickWordSpell.ced for Usage.
- Will return the string 'ok' or 'bad'
- depending on if the word is found or not.
-
- LOOKUP <word> --- Looks up word (really a grep pattern).
- See rexx/lookup.rexx for usage. `.*' is
- the match anything wild-card :-). `.' is
- the match one character wild-card, see a
- manual on grep or src/regex.c for more
- information.
-
- FILECHECK <filename> --- The ISpell server checks the named file, returns
- the filename of a temporary file that contains
- a list of words not found in the dictionary.
- The client is required to delete the temporary
- file when done with it. Be sure to include the
- complete path in the filename as there are no
- good ways to know the current directory of the
- ISpell server. See rexx/spellfile.rexx and
- rexx/ced/Spell.ced for usage.
-
- VERSION --- The ISpell server replies with its version string
- and a line of the currently compiled in ARexx
- commands that it will response to.
-
- EXIT --- Causes the ISpell server to terminate after
- replying to the request.
-